home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 33 / Amiga Format AFCD33 (Issue 117, Dec 1998).iso / -seriously_amiga- / programming / e / showmodulegmw / tools / qadc.readme < prev    next >
Text File  |  1998-09-07  |  1KB  |  70 lines
  1.  
  2.  
  3.    /¯¯¯¯¯¯¯\
  4.    |/¯¯¯¯¯\| UICK AUTODOC CONVERT
  5.    ||      |
  6.    ||      |
  7.    ||   \\_|
  8.    ||____\ /\__
  9.    \______/\___\
  10.  
  11.  
  12. This useful little tool will convert Quick Autodocs
  13. to AmigaGuide files so they can be used of Smgmw.
  14.  
  15. Usage:
  16.  
  17.     qadc autodoc newguide
  18.  
  19.     Example:
  20.  
  21.     qadc e:autodocs/asl.doc work:smgmwebber/Help/asl.guide
  22.  
  23.  
  24.  
  25. The Quickdoc must have a pattern like this:
  26.  
  27.  
  28. --- cut here --- (this line shouldn't be in the autodoc file)
  29. gadtools.library quick autodocs
  30.  
  31. NAME     : CreateContext
  32. FUNCTION : create a place for GadTools context data
  33. SYNOPSIS : gad = CreateContext(glistpointer)
  34.             D0       -114           A0
  35.  
  36. NAME     : CreateGadgetA
  37. FUNCTION : allocate and initialize a gadtools gadget
  38. SYNOPSIS : gad=CreateGadgetA(kind,previous,newgad,tagList)
  39.             D0      -30       D0     A0      A1     A2
  40.  
  41. NAME     : CreateMenusA
  42. FUNCTION : allocate and fill out a menu structure
  43. SYNOPSIS : menu=CreateMenusA(newmenu,tagList)
  44.             D0      -48         A0      A1
  45.  
  46. ... [snap]
  47.  
  48. --- cut here
  49.  
  50.  
  51. So if you've made your own library, let's say it's called
  52. flush.library. your autodoc would look like this:
  53.  
  54. ---- cut here --
  55. flush.library quick autodocs
  56.  
  57. NAME     : FlushAllMemory
  58. FUNCTION : Flush all the memory
  59.  
  60.  And you can write whatever you want here.
  61.  You could for example include a source example.
  62.  
  63.  All this text should be visible all the way to
  64.  the next "NAME     :" line.
  65.  
  66. NAME     : TakeTheMemoryBack
  67.  
  68. Here's the next function... and so on...
  69.  
  70.